Search
Description
Invanti Service Manager: Search step, fetches business object records based on the Full-Text (Keyword) / Criteria Query.
Limitation:
- The service request business object record cannot be searched using this plugin step since there is a different API endpoint provided to create service request.
- Few queries that have more than one operators (nested queries) may not provide correct output. For example, Priority eq '1' AND CauseCode eq 'Configuration' OR Approver eq 'AEApprover' AND Owner ne '$NULL'.
- If the query is to be provided as Owner ne '$NULL' OR (Priority eq '1' AND Approver eq 'AEApprover') as per the UI, it needs to be provided as Priority eq '1' AND Approver eq 'AEApprover' OR Owner ne ‘$NULL’ in the plugin as well as API. However, in API adding brackets is not allowed hence user may get incorrect results.
References:
- Documentation for creating an API Key:
https://help.ivanti.com/ht/help/en_US/ISM/2021/admin/Content/Configure/API/Using-REST-API-Key.htm
API documentation:
-
Search based on Full-Text:
https://help.ivanti.com/ht/help/en_US/ISM/2021/admin/Content/Configure/API/Full-Text-Search-API.htm -
Search based on Criteria Query/Filter:
https://help.ivanti.com/ht/help/en_US/ISM/2021/admin/Content/Configure/API/Get-Business-Object-by-Filter.htm
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step name | Name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow. |
| Connection | ||
| 2 | Tenant URL | Tenant URL of Ivanti Service Manager instance. The data type is String. This field is mandatory. |
| 3 | API Key | Specify or select API Key generated for the tenant. If checkbox above is enabled API Key field appears as Text box and accepts static values or variables. Else if checkbox above is disabled API Key field appears as a drop down containing values from previous steps to select from. The data type is String. This field is mandatory. |
| Input Fields | ||
| 1 | Business Object | Specify the internal name of business object for which search is to be executed.The data type is String. This field is mandatory. |
| 2 | Search Type | Select the type based on which the search is to be executed. Available options are: - Full-Text: On selection of this option, the Search Text field is enabled. - Criteria Query: On selection of this option, the Criteria Query field is enabled. - Both: On selection of this option, both, Search Text and Criteria Query fields are enabled. The data type is String. This field is mandatory. |
| 3 | Search Text | Specify the keyword based on which the full-text search is to be executed. Note: This field is mandatory, if Search Type is Full-Text or Both. |
| 4 | Criteria Query | Specify the criteria query/filter based on which the search is to be executed. Note: This field is mandatory, if Search Type is Criteria Query or Both. For criteria query sample, see Sample Criteria Query |
| 5 | Fetch Records Batch Size | Specify the batch size to fetch records, that is, number of records to be fetched in one batch. Default value: 25 |
| Output Fields | ||
| 1 | Field Name | Specify the field name to hold the records. |
| 2 | Output Field | Specify the output field to hold the Rec ID of the record created on successful plugin execution. |
Sample Criteria Query
- Priority eq '1'
- Status eq 'Active' AND Owner eq 'Alan Taylor'
- ActualCategory eq 'Backup' AND CauseCode eq 'Installation' OR Cost lt '100'
Note: Operators to be used in Criteria Query:
- Equal to: eq
- Not equal to: ne
- Greater than: gt
- Greater or Equal: ge
- Less than: lt
- Less or Equal: le